home *** CD-ROM | disk | FTP | other *** search
/ Chip 2004 December / 2004-12 CHIP.iso / CHIP / Porady / Srodowisko PHP-MySQL / WAMP5 1.3 / wamp5_1.3.exe / {app} / Apache / include / ap.h < prev    next >
C/C++ Source or Header  |  2004-02-16  |  7KB  |  160 lines
  1. /* Copyright 1999-2004 The Apache Software Foundation
  2.  *
  3.  * Licensed under the Apache License, Version 2.0 (the "License");
  4.  * you may not use this file except in compliance with the License.
  5.  * You may obtain a copy of the License at
  6.  *
  7.  *     http://www.apache.org/licenses/LICENSE-2.0
  8.  *
  9.  * Unless required by applicable law or agreed to in writing, software
  10.  * distributed under the License is distributed on an "AS IS" BASIS,
  11.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12.  * See the License for the specific language governing permissions and
  13.  * limitations under the License.
  14.  */
  15.  
  16. /*
  17.  * The ap_vsnprintf/ap_snprintf functions are based on, and used with the
  18.  * permission of, the  SIO stdio-replacement strx_* functions by Panos
  19.  * Tsirigotis <panos@alumni.cs.colorado.edu> for xinetd.
  20.  */
  21.  
  22. #ifndef APACHE_AP_H
  23. #define APACHE_AP_H
  24.  
  25. #ifdef __cplusplus
  26. extern "C" {
  27. #endif
  28.  
  29. API_EXPORT(char *) ap_cpystrn(char *, const char *, size_t);
  30. int ap_slack(int, int);
  31. int ap_execle(const char *, const char *, ...);
  32. int ap_execve(const char *, char * const argv[], char * const envp[]);
  33. API_EXPORT(int) ap_getpass(const char *prompt, char *pwbuf, size_t bufsiz);
  34.  
  35. #ifndef ap_strtol
  36. API_EXPORT(long) ap_strtol(const char *nptr, char **endptr, int base);
  37. #endif
  38.  
  39. /* small utility macros to make things easier to read */
  40.  
  41. #ifdef WIN32
  42. #define ap_killpg(x, y)
  43. #else
  44. #ifdef NO_KILLPG
  45. #define ap_killpg(x, y)        (kill (-(x), (y)))
  46. #else
  47. #define ap_killpg(x, y)        (killpg ((x), (y)))
  48. #endif
  49. #endif /* WIN32 */
  50.  
  51. /* ap_vformatter() is a generic printf-style formatting routine
  52.  * with some extensions.  The extensions are:
  53.  *
  54.  * %pA    takes a struct in_addr *, and prints it as a.b.c.d
  55.  * %pI    takes a struct sockaddr_in * and prints it as a.b.c.d:port
  56.  * %pp  takes a void * and outputs it in hex
  57.  *
  58.  * The %p hacks are to force gcc's printf warning code to skip
  59.  * over a pointer argument without complaining.  This does
  60.  * mean that the ANSI-style %p (output a void * in hex format) won't
  61.  * work as expected at all, but that seems to be a fair trade-off
  62.  * for the increased robustness of having printf-warnings work.
  63.  *
  64.  * Additionally, ap_vformatter allows for arbitrary output methods
  65.  * using the ap_vformatter_buff and flush_func.
  66.  *
  67.  * The ap_vformatter_buff has two elements curpos and endpos.
  68.  * curpos is where ap_vformatter will write the next byte of output.
  69.  * It proceeds writing output to curpos, and updating curpos, until
  70.  * either the end of output is reached, or curpos == endpos (i.e. the
  71.  * buffer is full).
  72.  *
  73.  * If the end of output is reached, ap_vformatter returns the
  74.  * number of bytes written.
  75.  *
  76.  * When the buffer is full, the flush_func is called.  The flush_func
  77.  * can return -1 to indicate that no further output should be attempted,
  78.  * and ap_vformatter will return immediately with -1.  Otherwise
  79.  * the flush_func should flush the buffer in whatever manner is
  80.  * appropriate, re-initialize curpos and endpos, and return 0.
  81.  *
  82.  * Note that flush_func is only invoked as a result of attempting to
  83.  * write another byte at curpos when curpos >= endpos.  So for
  84.  * example, it's possible when the output exactly matches the buffer
  85.  * space available that curpos == endpos will be true when
  86.  * ap_vformatter returns.
  87.  *
  88.  * ap_vformatter does not call out to any other code, it is entirely
  89.  * self-contained.  This allows the callers to do things which are
  90.  * otherwise "unsafe".  For example, ap_psprintf uses the "scratch"
  91.  * space at the unallocated end of a block, and doesn't actually
  92.  * complete the allocation until ap_vformatter returns.  ap_psprintf
  93.  * would be completely broken if ap_vformatter were to call anything
  94.  * that used a pool.  Similarly http_bprintf() uses the "scratch"
  95.  * space at the end of its output buffer, and doesn't actually note
  96.  * that the space is in use until it either has to flush the buffer
  97.  * or until ap_vformatter returns.
  98.  */
  99.  
  100. typedef struct {
  101.     char *curpos;
  102.     char *endpos;
  103. } ap_vformatter_buff;
  104.  
  105. API_EXPORT(int) ap_vformatter(int (*flush_func)(ap_vformatter_buff *),
  106.     ap_vformatter_buff *, const char *fmt, va_list ap);
  107.  
  108. /* These are snprintf implementations based on ap_vformatter().
  109.  *
  110.  * Note that various standards and implementations disagree on the return
  111.  * value of snprintf, and side-effects due to %n in the formatting string.
  112.  * ap_snprintf behaves as follows:
  113.  *
  114.  * Process the format string until the entire string is exhausted, or
  115.  * the buffer fills.  If the buffer fills then stop processing immediately
  116.  * (so no further %n arguments are processed), and return the buffer
  117.  * length.  In all cases the buffer is NUL terminated. The return value
  118.  * is the number of characters placed in the buffer, excluding the
  119.  * terminating NUL. All this implies that, at most, (len-1) characters
  120.  * will be copied over; if the return value is >= len, then truncation
  121.  * occured.
  122.  *
  123.  * In no event does ap_snprintf return a negative number.
  124.  */
  125. API_EXPORT_NONSTD(int) ap_snprintf(char *buf, size_t len, const char *format,...)
  126.                 __attribute__((format(printf,3,4)));
  127. API_EXPORT(int) ap_vsnprintf(char *buf, size_t len, const char *format,
  128.                  va_list ap);
  129. /* Simple BASE64 encode/decode functions.
  130.  * 
  131.  * As we might encode binary strings, hence we require the length of
  132.  * the incoming plain source. And return the length of what we decoded.
  133.  *
  134.  * The decoding function takes any non valid char (i.e. whitespace, \0
  135.  * or anything non A-Z,0-9 etc as terminal.
  136.  * 
  137.  * plain strings/binary sequences are not assumed '\0' terminated. Encoded
  138.  * strings are neither. But propably should.
  139.  *
  140.  */
  141. API_EXPORT(int) ap_base64encode_len(int len);
  142. API_EXPORT(int) ap_base64encode(char * coded_dst, const char *plain_src,int len_plain_src);
  143. API_EXPORT(int) ap_base64encode_binary(char * coded_dst, const unsigned char *plain_src,int len_plain_src);
  144.  
  145. API_EXPORT(int) ap_base64decode_len(const char * coded_src);
  146. API_EXPORT(int) ap_base64decode(char * plain_dst, const char *coded_src);
  147. API_EXPORT(int) ap_base64decode_binary(unsigned char * plain_dst, const char *coded_src);
  148.  
  149. /* Password validation, as used in AuthType Basic which is able to cope
  150.  * (based on the prefix) with the SHA1, Apache's internal MD5 and (depending
  151.  * on your platform either plain or crypt(3) passwords.
  152.  */
  153. API_EXPORT(char *) ap_validate_password(const char *passwd, const char *hash);
  154.  
  155. #ifdef __cplusplus
  156. }
  157. #endif
  158.  
  159. #endif    /* !APACHE_AP_H */
  160.